﻿Plugin: Clean Spellbook
Author: Low Post
Version: 1.3.0
__________________________________________________________________________________________

1. Description
2. Install/Uninstall
3. Known Bugs & Issues
4. Hosting Information
5. Contact
6. Changelog
7. Credits

==============
1. Description
==============

With proceeding play time more and more spells are added to the spellbook, but not depending 
on whether you have use for them or not and there's no way to get rid of them. At worst the 
spell book is that cloged with spells you have trouble finding your preferred ones.

That's where this plugin steps in: It adds a spellbook to the game that sorts your spells 
by school. Also you can make your character 'forget' one single spell, all spells belonging 
to a certain category or even all spells in the player's spellbook. These forgotten spells 
won't be deleted. They are stored (you might say 'written down in the spellbook') and can 
be restored at any time. They are marked with a '(Hidden)' in the line after their name.

The categories are:

	* Alteration
	* Conjuration
	* Destruction
	* Illusion
	* Mysticism
	* Restoration
	* Lesser Power

It's not possible to forget Greater Powers or abilities, and for sure diseases affecting 
the player aren't even displayed. This plugin's only aim is to help the player keep his 
spellbook clean.
Additionally, it's possible to equip spells with the Spellbook. For that purpose you have to 
press the SelectKey (Standart: L-Shift) while you click at the spell.
The Key can be changed by pressing the prefered new key while clicking at the Finish button 
in the main menu.
If you click at your current Spell while pressing the SelectKey it will be marked as a 
HotSpell. HotSpells are displayed before the other (normal) Spells so they are easier to find. 
To release a HotKey from its status click at it while pressing the SelectKey whilte it's 
either your current spell or hidden.

Additionally, it's possible to display more Information about every single spell, or to 
display hidden spells after the non-hidden ones (hidden HotSpell will be displayed before the 
normal not-hidden spells).
You can activate & deactivate these optional features in a submenu. To open this submenu 
click at the Finish button in the main menu while pressing the SelectKey. Everything else 
nessesary is described there.
Additionally, you can change the language and the material the Spellbook's pages are made of.

				ATTENTION:
	The Spellbook isn't a Book, but a Misc Item. Therefore, you have to search for 
			a Misc Item instead of a Book in your Inventory.

Clean Spellbook is usable in English and German language.
If you installed Pluggy v122 (or higher), the language is chosen automatically with the 
file size of the Oblivion.esm, otherwise with the Value of iLanguage [Controls] in the 
Oblivion.ini

				NOTE:
	If the value doesn't fit with your prefered language you ca change this with the 
	following console command (or the submenu mentioned above):
		set LPCSBLanguage to [code of the prefered language]
	Here's a list, wich value will result in wich language:
		LPCSBLanguage == 1	--> German
		everything else		--> English

The Spellbook can be activated in the Inventory, as well as lieing about somewhere in the 
world. This was implemented, so you can put the Spellbook in a bookcase and are still able to 
use it.
Although, this causes another problem: you can't pick it up like a normal item. Therefore, you 
have to hold the SelectKey while activating the Spellbook.

======================
2. Install/Uninstall
======================

The archive is OMOD ready, i.e. if you wish to create an *.omod file from it, you only need 
to open up the Oblivion Mod Manager, press the 'Create' button and add the archive by 
pressing 'Add archive' in the omod creator window. OBMM will do the rest.

If you don't use OBMM, just unzip the archive and copy the 'Clean Spellbook.esp' as well as 
the 'Clean Spellbook.bsa' to your ..\Oblivion\Data directory. Open up the Oblivion Launcher 
and activate the mod via double-click on the file name.

ATTENTION: This PI requires OBSE v0016 (or higher).

Uninstall:
----------
OMOD users will have to deactivate and delete the *.omod file, while non OMOD users need to 
delete the *.esp and the *.bsa in their ..\Oblivion\Data directory.

ATTENTION: Spells which are forgotten while deactivating can't be restored.

Update:
-------
It should be enough to replace the old files with the new ones.
If you want to err on the side of caution, certainly, you can make a Clean Save:
	 1.	Show all Spells and Save
	 2.	Uninstall the old Version
	(2.b	Start the Game and save in a new Slot)
	 3.	Install the new Version

======================
3. Known Bugs & Issues
======================

 - Spell merchants sell forgotten spells
 - The Spells aren't displayed in alphabetical order all the time
   Primarily this happens when a Spell is marked as a HotSpell, or released from this status
 - The Effect of a Spell won't be displayed correctly, if it uses an attribute, or a skill
   Maybe this will be fixed in a future OBSE-Version
 - If to many effects of a Spell are displayed the MessageBox may not fit into the screen.
   You can still navigate through the buttons using the arrow up/down key, so it's still 
   possible the exit the menu.
   The last Button is alwys the Finish button.
 - As long as you don't use a Plugin which reduces the font size the submenu for the settings 
   of the Spellbook doesn't fit into the screen.
 - If the MessageBox contains more then 4096 characters it will result in a CTD.
   Usually, this won't be a problem because this number isn't reached by a Page full of spells 
   each with 5 effects.
   Unfortunately, I can't do anything to increase the maximum number of characters possible, 
   because it's defined by OBSE. Maybe this will change somtimes in the future.

======================
4. Hosting Information
======================

As long as you don't change or remove files or information from the archive and name me as 
author you can upload it wherever you want. Just send me a message with the download link. 
You needn't wait for a permission, though.

If you'd like to do other stuff with my content, just ask. Don't worry, I won't bite. ;)


If I left Oblivion-Modding someday and you want to do something else then hosting this Plugin 
ask for a permission, first. ;)
If you can't get in contact with me (which means: no reply in a month or more using every 
way to contact me mentioned below) you can do whatever you want, as long as you give 
proper credits.

==========
5. Contact
==========

You can contact me (Low Post) via Private Message in one of the following forums 
or by sending me a mail.

Mail address
	<spamviech@web.de>

Official ES forum
	http://www.bethsoft.com/bgsforums/

Multimediaxis
	http://www.multimediaxis.net/index.php
ElderScrollsGames.de
	http://www.elderscrollsgames.de/distribution/
Newraven.net
	http://forum.newraven.net/
World of Elder Scrolls
	http://forum.worldofplayers.de/forum/index.php
Scharesoft forum
	http://www.scharesoft.de/joomla/forum/index.php

============
6. Changelog
============

1.3.0:	- Improved Version of the Mesh & Textures for the Spellbook. (Thanks to Katan)
		* Toggeling the color of the pages possible in the Settings-Submenu.
	- Implementing Strings to enable direct embedding of StringGameSettigs.
	- If Pluggy is installed the Language is chosen by the size of the Oblivion.esm.
	- Changing the Language is now possible in the setting submenu, too.
	- Some internal changes (only one Faction per Language).

1.2.1:	- Fixed a Bug not displaying any effect if you selected 'All'

1.2.0:	- It is now possible to activate the Spellbook if it lay somewehere in the world 
	  (e.g. a bookshelf)
		* through pressing the SelectKey it get's added to the inventory
	- The order how the spells are sorted is updated immediately
	- HotSpells
		* Mark a Spell as a HotSpell by clicking on it while it's your current Spell 
		  and while pressing the SelectKey.
		* HotSpell are always displayed before the other Spell, it doesn't matter if 
		  they're currently hidden or not.
			# If LPCSBMoveHiddenToBack != 0 hidden HotSpells will be displayed at 
			  the end of the HotSpells
		* To release a HotSpell from his status click on it while pressing the 
		  SelectKey while it's either your current spell or hidden.
	- Additional Information about a Spell can be displayed:
		* If the Spell is currently hidden
		* If the Spell is your current selected Spell
		* Every effect of the Spell with (if available) Magnitude, Area, 
		  Duration & Range
		* Magicka cost of a Spell (together with your current Magicka value) & the 
		  required Skill to use the Spell (if your skill is high enough only the magic 
		  school is displayed)
		* If the Spell is hostile
		* All Information (except current Spell/Hidden/HotSpell) is optional and 
		  usually won't be displayed. The governing Globals are:
			# LPCSBShowEffects
			# LPCSBShowHostility
			# LPCSBShowMagickaCost
			# LPCSBShowMagicSchool
	- Added a submenu to adjust all globals (exept LPCSBLanguage). Open it by clicking on 
	  the finish button in the main menu while pressing the SelectKey

1.1.4:	- Fixed a Bug which prevented the first MessageBox from beeing displayed if Pluggy 
		hasn't been installed.

1.1.3:	- Fixed some spelling mistakes (DV)
	- Fixed a possible CTD (EV)

1.1.2:	- Fixed a Bug with displaying the SelectKey which caused the game to display just 
		a blank Space instead of a Key with certain SelectKeys (e.g. Tab).

1.1.1:	- Fixed a Bug with the check of OBSE
	- Added LPCSBLanguage
	- Optional: Fixed a bug which caused the wrong key to by displayed for Selecting 
		a spell (non QWERTY-Keyboards).
		Requires Pluggy 85 or higher.

1.1.0:	- Hidden spells are now displayed after still present ones (optional).
		This feature can be activated with the following console command:
			set LPCSBMoveHiddenToBack to 1
	- Button to Show/Hide all spells of a group is now only displayed on the first page.
	- Every Page has a Button to Exit the Spellbook (Finish)
	- Added the possibility to use the Spellbook via HotKey
	- Added the possibility to equip Spells if you press a changable key 
		(Standart: L-Shift) while selecting the spell.
	- Fixed a Bug which caused the Starting Spells to stay equipped, although they have 
		been forgotten.

1.0.6:	- Fixed a Bugs which made a third activation of the Spellbook impossible.

1.0.5:	- Display of the Spellbook-Icon and the OBSE-Revision in the StartUp-Text if 
		OBSE v0015 (or higher) has been installed.

1.0.4:	- Use of the OBSE-Commands AddSpellNS & RemoveSpellNS to inhibit the blocking of 
		other messages if OBSE v0015 (or higher) has been installed.

1.0.3:	- Fixed a Bug in the Submenu für Alteration, Conjuration, Destruction & Illusion (EV)

1.0.2:  - Fixed a Bug in the Mysticism Submenu (EV)
	- Removing the Questitem-Status from the Spellbook
	- Adding a Mesh/Icon for the Spellbook (thx to Katan)

1.0.1:	- Automating Chosing of the language

1.0:	- Initial release

==========
7. Credits
==========
 - Katan for creating this idea in my mind (although he didn't plan it ;) )
 - Katan again for testing
 - Katan for the third time, because he created the Mesh, Texture & Icon of the Spellbook
 - Muecke49, also for testing
 - allnet & SirTroy for testing, too
 - the OBSE team for making this possible
 - Elys for creating Pluggy. StringToTxtFile makes debugging so much easier. :)
 - GlasMond, because he'd do awful things if I wouldn't mention him